home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / dev / lang / SmallEiffel.lha / SmallEiffel / man / finder.txt < prev    next >
Text File  |  1998-12-22  |  4KB  |  85 lines
  1.  
  2.                              The finder command
  3.                                       
  4.    Usage
  5.    
  6.    finder <Class>
  7.    
  8.    Command finder tells you which file is loaded when searching for an
  9.    Eiffel <Class>.
  10.    When an Eiffel file is found, finder prints the full path name on
  11.    standard output.
  12.    The exit status is set GENERAL.exit_success_code only when an existing
  13.    file is found (thus allowing usage of command finder in shell
  14.    scripts).
  15.    
  16.    To see the loading path used by SmallEiffel, you can for example type
  17.    the finder command using a bad (inexistant) class name. The default
  18.    loading path may be updated (see READ_ME file of the sys directory).
  19.    
  20.    When invoked without any argument, the finder command prints this
  21.    help.
  22.    
  23.    Where does finder search ?
  24.    
  25.    The algorithm used by SmallEiffel to look for an Eiffel source file is
  26.    the following:
  27.    
  28.    1. Lower case filenames - SmallEiffel looks all along the loading path
  29.    using <class> name in lower case as tail. If needed, the Eiffel suffix
  30.    (".e") is added automatically. SmallEiffel only looks for suffixed
  31.    files on the disk. Only the first file encountered according to the
  32.    order of the path is taken in account. File is always supposed to have
  33.    the same name as the inside class definition.
  34.    
  35.    2. Renamed files - When the above search has failed to find a file,
  36.    SmallEiffel tries to search for files "rename.se" in all directories
  37.    of the path.
  38.    A file "rename.se" allows the user to put in file "foo" the class
  39.    "bar" for example.
  40.    Such renaming facilities has been added especially for DOS (file names
  41.    are limited to 8 characters).
  42.    Each line of a "rename.se" file is a renaming directive containing two
  43.    names, first the full name and then the short name to use in the
  44.    directory where the "rename.se" file is.
  45.    File "SmallEiffel/misc/rename.se" is an example of a "rename.se" file
  46.    to put in SmallEiffel/lib_std/ for DOS.
  47.    
  48.    Thus, knowing the algorithm of SmallEiffel to find a class file, it is
  49.    better not to use the renaming facilities to speed up class loading.
  50.    
  51.    3. Upper case filenames - Finally, when both previous steps did not
  52.    find the required Eiffel class file, SmallEiffel looks along the
  53.    loading path for a file bearing the class name upper in upper case
  54.    letters. If needed, the Eiffel suffix ".e" is added automatically.
  55.    One must note that the overhead to find an upper case file name is not
  56.    negligeable at all and that a lower case file name may hide some upper
  57.    case name.
  58.    
  59.    Changing the default loading path
  60.    
  61.    The default global loading path is set using contents of file
  62.    loadpath.system (see [1]system configuration). To change this default
  63.    loading path, you need to add a special file which name is
  64.    "loadpath.se" in the directoy you type a command of SmallEiffel
  65.    (compile, finder, pretty, ...).
  66.    Each line of the file "loadpath.se" must be an existing directory path
  67.    or the absolute path of another "loadpath.se" file to include
  68.    recursively.
  69.    All directories of the local "loadpath.se" file are added ahead of the
  70.    default loading path.
  71.    
  72.    Hint: to check that your loading path is correctly set, just type
  73.    command finder using an unknown class name as argument. Also note that
  74.    an empty line in a loadpath.se file may add the current working
  75.    directory in a place you don't want.
  76.    
  77.                                    [Line]
  78.    Copyright © Dominique COLNET and Suzanne COLLIN - [2]<colnet@loria.fr>
  79.                   Last update: Tuesday November 3rd, 1998 
  80.  
  81. References
  82.  
  83.    1. file://localhost/home/colnet/SmallEiffel/man/man/system.html#loadpath
  84.    2. mailto:colnet@loria.fr
  85.